Disable service worker by default #3817

iansu · 2018-01-16T17:59:29Z

Addresses disabling service worker by default from #2554.

iansu · 2018-01-16T18:35:10Z

packages/react-scripts/template/src/index.js

@@ -2,7 +2,16 @@ import React from 'react';
 import ReactDOM from 'react-dom';
 import './index.css';
 import App from './App';
-import registerServiceWorker from './registerServiceWorker';
+import registerServiceWorker, {


Importing both of these results in a lint error because only one of them is ever used. We could override eslint for this line, we could only import one and update the comment below (ugh) or we could do something else entirely like only using registerServiceWorker and passing it a boolean to enable/disable.

gaearon · 2018-01-16T19:03:48Z

How about using * import?

import * as serviceWorker from './serviceWorker';

// ...
serviceWorker.unregister();

iansu · 2018-01-16T19:06:56Z

Good suggestion Dan. I'll make that change.

iansu · 2018-01-16T19:24:33Z

If I use the * import and don't change registerServiceWorker.js the call to registerServiceWorker() has to be registerServiceWorker.default() which is kind of gross.

Is it okay to change registerServiceWorker.js?

zyzski · 2018-01-16T19:26:24Z

I'd say registerServiceWorker could use some edits, at least in the comments to tell the dev it's opt-in and how that opt-in works.

What about adding a new function in registerServiceWorker.js to help devs destroy a service worker if their users are stuck with it by mistake? AFAIK .unregister() doesn't execute unless the rendered service-worker.js has changed.

Was looking at adding something like this to my own rSW.js

gaearon · 2018-01-16T19:28:18Z

@iansu I'm proposing to make both functions named exports.

jeffposnick · 2018-01-16T19:29:13Z

Thanks for taking this on, @iansu!

As it's currently implemented, unregister() is

export function unregister() {
  if ('serviceWorker' in navigator) {
    navigator.serviceWorker.ready.then(registration => {
      registration.unregister();
    });
  }
}

navigator.serviceWorker.ready is a promise that will resolve whenever there's an active service worker whose scope includes the current URL. Assuming that there is an active service worker, that promise will resolve consistently on each page load. There is no requirement that the service worker file has actually changed in order for it to resolve.

I touched some of the code in registerServiceWorker.js initially, and am happy for folks to make changes as long as the general logic remains consistent.

petetnt · 2018-01-16T19:33:21Z

packages/react-scripts/template/src/serviceWorker.js

@@ -18,7 +18,7 @@ const isLocalhost = Boolean(
    )
 );

-export default function register() {
+export function register() {


The default export still needs to be registerServiceWorker too though (even if both are named exports too) for it to be backwards compatible (even if this lands to a major version update 2.0.0, it would be unneccessary to break everyones build for such a tiny change).

Still partial to passing the boolean in myself: #2554 (comment)

It won't break anyone's build because this part is copied into every project. Even if we changed completely the API between them, we could've shipped that in any patch release IMO.

iansu · 2018-01-16T19:39:59Z

Thanks for the feedback everyone. I think I've addressed it all.

gaearon · 2018-01-16T19:44:53Z

packages/react-scripts/template/src/index.js


 ReactDOM.render(<App />, document.getElementById('root'));
-registerServiceWorker();
+
+// By default we make sure that no service worker is registered. If you would


People reading this probably don't know what service worker is.
Can you rewrite this so it's a bit less wordy, and also understandable to most folks?

Now that's a challenge! 😀

I guess we can remove the first sentence and maybe link to that Google page from the docs about what a service worker is. Alternatively we could just link to the "Making a Progressive Web App" section of the CRA docs. I'll work on it.

I was thinking something like

// If you want your app to work offline and load faster, you can change “disable” below to “enable”. // Note this comes with some deployment pitfalls. // Learn more about service workers: <...>

If it helps, https://developers.google.com/web/fundamentals/primers/service-workers/ attempts to be a one-stop landing page for a service worker overview, and https://developers.google.com/web/progressive-web-apps/ is a similar landing page for PWAs in general.

iansu · 2018-01-16T20:19:26Z

I've updated the comments about using Service Worker in index.js. Currently the link points to the "Making a Progressive Web App" section of the CRA docs.

piotr-cz · 2018-01-19T11:07:55Z

Note that is in comment (If you want your app to work offline and load faster...)
should go to /README.md and packages/react-scripts/template/README.md#making-a-progressive-web-app as well

gaearon · 2018-01-19T11:50:38Z

Yep, we’ll update the docs before the release.
#3864

* WIP disable service worker by default (facebook#2554) * Updated service worker registration * Readd default export in registerServiceWorker.js * Updated comments about using Service Worker * Call it serviceWorker * Nits

quantumproducer · 2018-03-18T15:16:24Z

+1 for this. Deployed to an HTTP site and my script is erroring because of service worker

ghost · 2018-08-17T18:05:44Z

Any idea when this will be released? Nobody removes it where I work and then it causes all sorts of problems in staging that the senior devs have to fix. ~~It also causes problems in development since every new app defaults to localhost:3000 and the service worker will be serving up old artifacts for that address.~~ Actually, during development the times that it caused problems was when we were not using localhost, but an actual domain.

bugzpodder · 2018-08-18T01:00:23Z

This will be released as part of 2.0 release. Note that this only affects the new app template, that means if an app was already bootstrapped with service worker, upgrade to 2.0 will not have any impact. If you have an existing worker that makes uses of service workers in production, you'll have to manually clean it up by unregistering.

* WIP disable service worker by default (facebook#2554) * Updated service worker registration * Readd default export in registerServiceWorker.js * Updated comments about using Service Worker * Call it serviceWorker * Nits

WIP disable service worker by default (facebook#2554)

acdd348

facebook-github-bot added the CLA Signed label Jan 16, 2018

iansu commented Jan 16, 2018

View reviewed changes

Updated service worker registration

5e15920

petetnt reviewed Jan 16, 2018

View reviewed changes

Readd default export in registerServiceWorker.js

c6f3ca2

gaearon added the tag: breaking change label Jan 16, 2018

gaearon added this to the 2.0.0 milestone Jan 16, 2018

gaearon reviewed Jan 16, 2018

View reviewed changes

viankakrisna mentioned this pull request Jan 16, 2018

add log message for service worker doc #3684

Closed

Updated comments about using Service Worker

3402a41

gaearon added 2 commits January 19, 2018 00:13

Call it serviceWorker

184cec4

Nits

da2dce0

gaearon merged commit 0e51eef into facebook:next Jan 19, 2018

This was referenced Jan 19, 2018

Provide callbacks in registerServiceWorker (1.x) #3375

Closed

Service Workers - Consolidated issues list #2554

Closed

Why was service worker merged into create react app? #2398

Closed

Update docs for service worker integration #3864

Closed

This was referenced Jan 19, 2018

Remove the navigateFallback behavior from the generated service worker #3419

Merged

Bring back navigateFallback behavior in service worker on next branch (Reverts #3419) #3870

Closed

maoberlehner mentioned this pull request Feb 12, 2018

feature request: add service-worker support vuejs-templates/webpack#647

Closed

bugzpodder mentioned this pull request May 30, 2018

Disable service workers until issues fixed #2995

Closed

TobiaszCudnik mentioned this pull request Jan 3, 2019

Service-worker in Carlo? RiseVision/rise-react-wallet#164

Closed

lock bot locked and limited conversation to collaborators Jan 19, 2019

iansu deleted the disable-service-worker branch October 18, 2019 05:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Disable service worker by default #3817

Disable service worker by default #3817

iansu commented Jan 16, 2018

iansu Jan 16, 2018

gaearon commented Jan 16, 2018 •

edited

Loading

iansu commented Jan 16, 2018

iansu commented Jan 16, 2018

zyzski commented Jan 16, 2018 •

edited

Loading

gaearon commented Jan 16, 2018

jeffposnick commented Jan 16, 2018

petetnt Jan 16, 2018 •

edited

Loading

gaearon Jan 19, 2018

iansu commented Jan 16, 2018

gaearon Jan 16, 2018

iansu Jan 16, 2018

gaearon Jan 16, 2018

jeffposnick Jan 16, 2018

iansu commented Jan 16, 2018

piotr-cz commented Jan 19, 2018

gaearon commented Jan 19, 2018

quantumproducer commented Mar 18, 2018

ghost commented Aug 17, 2018 •

edited by ghost

Loading

bugzpodder commented Aug 18, 2018

Disable service worker by default #3817

Disable service worker by default #3817

Conversation

iansu commented Jan 16, 2018

iansu Jan 16, 2018

Choose a reason for hiding this comment

gaearon commented Jan 16, 2018 • edited Loading

iansu commented Jan 16, 2018

iansu commented Jan 16, 2018

zyzski commented Jan 16, 2018 • edited Loading

gaearon commented Jan 16, 2018

jeffposnick commented Jan 16, 2018

petetnt Jan 16, 2018 • edited Loading

Choose a reason for hiding this comment

gaearon Jan 19, 2018

Choose a reason for hiding this comment

iansu commented Jan 16, 2018

gaearon Jan 16, 2018

Choose a reason for hiding this comment

iansu Jan 16, 2018

Choose a reason for hiding this comment

gaearon Jan 16, 2018

Choose a reason for hiding this comment

jeffposnick Jan 16, 2018

Choose a reason for hiding this comment

iansu commented Jan 16, 2018

piotr-cz commented Jan 19, 2018

gaearon commented Jan 19, 2018

quantumproducer commented Mar 18, 2018

ghost commented Aug 17, 2018 • edited by ghost Loading

bugzpodder commented Aug 18, 2018

gaearon commented Jan 16, 2018 •

edited

Loading

zyzski commented Jan 16, 2018 •

edited

Loading

petetnt Jan 16, 2018 •

edited

Loading

ghost commented Aug 17, 2018 •

edited by ghost

Loading